/*
 * Licensed to ObjectStyle LLC under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ObjectStyle LLC licenses
 * this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package io.bootique.help.config;

import io.bootique.meta.MetadataNode;

import java.util.function.Predicate;

public interface ConfigHelpGenerator {

    /**
     *
     * @param out Appendable that will be used to append data to
     * @param predicate The predicate to configure stream filter
     * @since 2.0
     */
    void append(Appendable out, Predicate<MetadataNode> predicate);

    default void append(Appendable out) {
        append(out, metadataNode -> true);
    }

    default String generate() {
        StringBuilder out = new StringBuilder();
        append(out);
        return out.toString();
    }
}
